type(feat): Implemented PanelUI Classes and Tests by Temidayo32 · Pull Request #338 · mozilla/FoxPuppet

Temidayo32 · 2025-01-26T21:55:56Z

Because

This commit implements PanelUI functionality

This commit

Implemented PanelUI Class and Tests

Fixes #313

Temidayo32 · 2025-01-26T22:07:58Z

This is still WIP. Failure is because tests do not meet 95% coverage yet.

.github/workflows/linux_tests.yml

b4handjr · 2025-02-06T22:32:38Z

foxpuppet/windows/browser/panel_ui/panel_ui.py

+    def verify_links_in_awesome_bar(self, links: list, new_window: bool = False) -> list:
+        """
+        Verifies that the provided links appear in the awesome bar.
+        Args:
+            links `list`: A list of links to be verified.
+
+        Returns:
+            list: A list of links that were not found in the awesome bar.
+        """
+        if new_window:
+            self.open_new_window()
+        else:
+            self.open_new_tab()
+        self.switch_to_new_window_or_tab()
+        for link in links:
+            self.selenium.get(link)
+        return self.awesome_bar(links)
+
+    def verify_private_browsing_links_not_in_awesome_bar(self, links: list) -> list:
+        """
+        Verifies that the provided links visited in private browing session do not appear in the awesome bar.
+        Args:
+            links `list`: A list of links to be verified.
+
+        Returns:
+            list: A list of links that appeared in the awesome bar during private browsing.
+        """
+        initial_window_handle = self.selenium.current_window_handle
+        self.open_private_window()
+        self.switch_to_new_window_or_tab()
+
+        for link in links:
+            self.selenium.get(link)
+
+        self.selenium.switch_to.window(initial_window_handle)
+        return self.awesome_bar(links)
+
+    def verify_links_in_history(self, links: list, new_window: bool = False) -> list:
+        """
+        Verifies that the provided links appear in the history.
+        Args:
+            links `list`: A list of links to be verified.
+
+        Returns:
+            list: A list of links that were not found in the history.
+        """
+        if new_window:
+            self.open_new_window()
+        else:
+            self.open_new_tab()
+        self.switch_to_new_window_or_tab()
+        for link in links:
+            self.selenium.get(link)
+        self.open_panel_menu()
+        self.open_history_menu()
+        urls = []
+        for link in links:
+            if not self.is_present(link):
+                urls.append(link)
+        return urls
+
+    def verify_private_browsing_links_not_in_history(
+        self,
+        links: list,
+    ) -> list:
+        """
+        Verifies that the provided links visited in private browsing session do not appear in the history.
+        Args:
+        links (`list[str]`): List of URLs visited during private browsing session
+        history (`History`): An instance of the History class used to check if a link is present in the history.
+
+        Returns:
+            list: A list of links that were found in the history during the private browsing session.
+        """
+        invalid_links = []
+        initial_window_handle = self.selenium.current_window_handle
+        self.open_private_window()
+        self.switch_to_new_window_or_tab()
+
+        for link in links:
+            self.selenium.get(link)
+
+        self.selenium.switch_to.window(initial_window_handle)
+        self.open_panel_menu()
+        self.open_history_menu()
+        for link in links:
+            if self.is_present(link):
+                invalid_links.append(link)
+        return invalid_links
+


What's the logic behind these additions? These seem like actions that a user would do. Are you expecting a user to supply a list of URLs for these methods to verify? Why wouldn't they just do that themselves?

Yeah, you are right. The actions mirror what a user would do manually, but given that this is a test automation tool, I think its purpose is always to automate manual user actions. Because technically, this isn't user functionality - it's testing infrastructure. In this sense, I try to automate certain expected behaviors of Private Window browsing vs Normal Window browsing, history etc.

Yeah, the user will provide a list of URLs

Remember, we are just trying to programmatically represent a way for a user to interact with Firefox. We don't want to assume what combinations they will do, just provide them a way to do them.

Okay, that makes good sense. I will move those methods to tests. So they serve as part of FoxPuppet test suite. Will that be good or I just remove them totally.

Desktop test has similar tests: https://github.com/mozilla/fx-desktop-qa-automation/blob/main/tests/security_and_privacy/test_private_session_awesome_bar_exclusion.py

b4handjr

Heading in the right direction with this. I think there will need to be some sort of History class so that we can contain the History specific interactions in one place.

foxpuppet/windows/browser/panel_ui/panel_ui.py

foxpuppet/windows/browser/window.py

b4handjr · 2025-02-07T21:57:30Z

foxpuppet/windows/browser/window.py

            )
            return self.bookmark

+    def wait_for_panel_ui(


When would a user want to wait for the panel ui to show? Can you explain a scenario?

This is the actual correct docstring:
Wait for the specified PanelUI item to be displayed.
That was misleading. There is no reason to wait for panel_ui as it is visible once the browser is opened.

PanelUI item, here, referring to menu items in the Panel Ui dropdown. History, for instance.

foxpuppet/windows/browser/window.py

b4handjr · 2025-02-07T21:59:34Z

tests/test_panel_ui.py

+    selenium.get(url)
+    panel_ui.open_history_menu()
+    panel_ui.clear_history()
+    import time


You can put this import at the top even if you just use it here

Temidayo32 · 2025-02-08T15:17:25Z

Heading in the right direction with this. I think there will need to be some sort of History class so that we can contain the History specific interactions in one place.

Yes, I tried to do that initially. But this was difficult using the same property(history) and wait_for_history method defined on the BrowserWindow class as we did with others, especially using the Panel-UI, which in the dom is a list and all items are visible. Suppose we decided to extend later on by adding more list items like PrivateWindow or Download. In that case, it will prove difficult to interact with a specific one since they will all be visible.

b4handjr

Excellent progress. I see some tests here that aren't quite testing the functionality of FoxPuppet but more so the functionality of Firefox. Can you identify which tests those are?

b4handjr · 2025-02-10T20:25:33Z

foxpuppet/windows/browser/navbar.py

+        """Check if the provided links are present in the url bar's suggestions."""
+        urls = []
+        with self.selenium.context(self.selenium.CONTEXT_CHROME):
+            for link in links:
+                url_bar = self.selenium.find_element(*NavBarLocators.INPUT_FIELD)
+                url_bar.clear()
+                url_bar.send_keys(link)
+
+                self.wait.until(
+                    lambda _: self.selenium.find_elements(*NavBarLocators.SEARCH_RESULTS)
+                )
+
+                search_results = self.selenium.find_elements(
+                    *NavBarLocators.SEARCH_RESULT_ITEMS
+                )
+
+                for result in search_results:
+                    url_span = result.find_element(*NavBarLocators.SEARCH_RESULT_ITEM)
+                    if url_span.text in link:
+                        if len(url_span.text) != 0:
+                            urls.append(link)
+                            break


This should be a separate method. If you need to create a UrlBar class to house it, that is fine, but this url_bar should be a property that just returns a class.

b4handjr · 2025-02-10T20:26:48Z

foxpuppet/windows/browser/panel_ui/panel_ui.py

        return panel_items.get(_id, PanelUI)(window, root)

+    @property
+    def is_barged(self) -> bool:


I can see where you get this name from but would a user understand what barged means? Honestly, if I didn't see the get_attribute("barged") I wouldn't know what it meant.

foxpuppet/windows/browser/window.py

tests/test_panel_ui.py

b4handjr

Almost there. I think we can remove some checks and functions but there are also a few methods that we need to make sure they're doing what they say they will do.

foxpuppet/windows/browser/panel_ui/panel_ui.py

tests/test_panel_ui.py

b4handjr · 2025-02-12T18:02:55Z

foxpuppet/windows/browser/urlbar.py

+    def check_suggestions(self, links: list) -> list:
+        """Check if the provided links are present in the URL bar's suggestions."""
+        urls = []
+        with self.selenium.context(self.selenium.CONTEXT_CHROME):
+            for link in links:
+                url_bar = self.selenium.find_element(*URLBarLocators.INPUT_FIELD)
+                url_bar.clear()
+                url_bar.send_keys(link)
+
+                self.wait.until(
+                    lambda _: self.selenium.find_elements(*URLBarLocators.SEARCH_RESULTS)
+                )
+
+                search_results = self.selenium.find_elements(
+                    *URLBarLocators.SEARCH_RESULT_ITEMS
+                )
+
+                for result in search_results:
+                    url_span = result.find_element(*URLBarLocators.SEARCH_RESULT_ITEM)
+                    if url_span.text in link and len(url_span.text) != 0:
+                        urls.append(link)
+                        break
+        return urls


Let's save this for now and just return the URLs that get shown in the url bar that are suggested.

tests/test_panel_ui.py

foxpuppet/windows/browser/panel_ui/panel_ui.py

b4handjr

Looking good. I think we're almost there.

foxpuppet/windows/browser/panel_ui/panel_ui.py

foxpuppet/windows/browser/urlbar.py

foxpuppet/windows/browser/panel_ui/panel_ui.py

b4handjr

Nice changes! Just a couple things and ill have Ben C look at this too.

foxpuppet/windows/browser/panel_ui/panel_ui.py

b4handjr · 2025-02-21T17:12:08Z

pytest.ini

+addopts = -vvv --driver Firefox --cov --cov-fail-under=95 --html=results/report.html --self-contained-html
+testpaths = tests


Please add a newline

b4handjr

Adding these based on our chat

b4handjr · 2025-02-21T17:50:34Z

foxpuppet/windows/browser/panel_ui/panel_ui.py

+                """,
+                    self.selenium.find_element(*PanelUILocators.HISTORY_DIALOG_BUTTON),
+                )
+            self.selenium.switch_to.default_content()


We shouldn't need to switch_to since we are using with

tests/test_panel_ui.py

b4handjr · 2025-02-21T18:11:01Z

foxpuppet/windows/browser/panel_ui/panel_ui.py

+    def clear_history(self):
+        """
+        Clears the browsing history.
+        """


I wonder if we can confirm the history is cleared some way. What do you think?

Yes, the history_items method

ben-c-at-moz

This all looks good, I think addressing that sleep command is the only new thing I can find in here that I think needs to change. I would definitely make absolutely sure you don't run find_elements() on anything until you KNOW it exists, as it doesn't include the same implicit wait as find_element() does.

b4handjr · 2025-02-25T16:07:32Z

foxpuppet/windows/browser/panel_ui/panel_ui.py

+            self.wait.until(
+                lambda _: self.selenium.execute_script("return document.readyState")
+                == "complete",
+                message="New window document not fully loaded",
+            )


Is this needed?

Yes, this more accurately addresses the root issue compared to time.sleep

b4handjr

! final thing and I think this is good

b4handjr · 2025-02-25T19:20:04Z

tests/test_panel_ui.py

+    selenium.get(url)
+    panel_ui.open_history_menu()
+    browser_history.clear_history()
+    time.sleep(1)


Do you still need this sleep?

b4handjr

Looks great!! Thanks for working on this and sticking with it, this is a great addition and will go a long way to helping us expand FoxPuppets offerings!

Temidayo32 changed the title ~~Implemented PanelUI Classes and Tests~~ type(feat): Implemented PanelUI Classes and Tests Feb 3, 2025

Temidayo32 requested a review from b4handjr February 3, 2025 22:05

Temidayo32 force-pushed the panelui branch 4 times, most recently from 731b778 to 3d6cc7a Compare February 4, 2025 18:19

b4handjr reviewed Feb 4, 2025

View reviewed changes

.github/workflows/linux_tests.yml Show resolved Hide resolved

Temidayo32 force-pushed the panelui branch 5 times, most recently from e548f64 to 8d8f563 Compare February 5, 2025 14:26

b4handjr requested review from b4handjr and ben-c-at-moz February 6, 2025 17:58

b4handjr suggested changes Feb 6, 2025

View reviewed changes

b4handjr suggested changes Feb 7, 2025

View reviewed changes

b4handjr suggested changes Feb 10, 2025

View reviewed changes

Temidayo32 requested a review from b4handjr February 12, 2025 17:12

b4handjr suggested changes Feb 12, 2025

View reviewed changes

Temidayo32 force-pushed the panelui branch from cd60c07 to b5ecbcb Compare February 20, 2025 14:46

Temidayo32 added 6 commits February 20, 2025 18:38

Implemented PanelUI Classes and Tests

23bcee4

Extended Panel UI methods and tests

c45b7db

Added History SubClass

5008d76

Removed FoxPuppet's unrelated tests

dbab333

Adjusted Panel UI methods

b963ae2

Added pytest.ini

fe817cd

Temidayo32 force-pushed the panelui branch from b5ecbcb to fe817cd Compare February 20, 2025 17:50

b4handjr suggested changes Feb 20, 2025

View reviewed changes

Added Private Window Test and Nit fixes

098d505

b4handjr suggested changes Feb 20, 2025

View reviewed changes

foxpuppet/windows/browser/panel_ui/panel_ui.py Show resolved Hide resolved

foxpuppet/windows/browser/panel_ui/panel_ui.py Outdated Show resolved Hide resolved

Temidayo32 force-pushed the panelui branch 3 times, most recently from 4e18ec3 to 19a0b38 Compare February 21, 2025 13:44

b4handjr reviewed Feb 21, 2025

View reviewed changes

b4handjr suggested changes Feb 21, 2025

View reviewed changes

fixed private window method

db54174

Temidayo32 force-pushed the panelui branch from 19a0b38 to db54174 Compare February 21, 2025 21:56

ben-c-at-moz reviewed Feb 25, 2025

View reviewed changes

b4handjr reviewed Feb 25, 2025

View reviewed changes

Temidayo32 force-pushed the panelui branch from e9445c0 to b4774fa Compare February 26, 2025 14:11

Removed time.sleep

e2ae56e

Temidayo32 force-pushed the panelui branch from b4774fa to e2ae56e Compare February 26, 2025 14:15

b4handjr approved these changes Feb 26, 2025

View reviewed changes

Merge branch 'main' into panelui

0f8a715

b4handjr merged commit 6783fd2 into mozilla:main Feb 26, 2025
7 checks passed

		addopts = -vvv --driver Firefox --cov --cov-fail-under=95 --html=results/report.html --self-contained-html
		testpaths = tests No newline at end of file

Conversation

Temidayo32 commented Jan 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Temidayo32 commented Jan 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Temidayo32 Feb 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Temidayo32 Feb 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

b4handjr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Temidayo32 commented Feb 8, 2025

Uh oh!

b4handjr left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

b4handjr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

b4handjr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

b4handjr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Temidayo32 commented Jan 26, 2025 •

edited

Loading

Temidayo32 commented Jan 26, 2025 •

edited

Loading

Temidayo32 Feb 7, 2025 •

edited

Loading

Temidayo32 Feb 7, 2025 •

edited

Loading